<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ipipsu: Ipipsu_v1_0</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ipipsu
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__ipipsu__v1__0.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Ipipsu_v1_0</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ipi_psu___target.html">XIpiPsu_Target</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structure used to refer IPI Targets.  <a href="struct_x_ipi_psu___target.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ipi_psu___config.html">XIpiPsu_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the device.  <a href="struct_x_ipi_psu___config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="struct_x_ipi_psu.html" title="The XIpiPsu driver instance data. ">XIpiPsu</a> driver instance data.  <a href="struct_x_ipi_psu.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gac400a6861c1d0ee565ad5fac914a7220"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#gac400a6861c1d0ee565ad5fac914a7220">XIpiPsu_ReadReg</a>(BaseAddress,  RegOffset)&#160;&#160;&#160;Xil_In32((BaseAddress) + (RegOffset))</td></tr>
<tr class="memdesc:gac400a6861c1d0ee565ad5fac914a7220"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the register specified by the base address and offset.  <a href="#gac400a6861c1d0ee565ad5fac914a7220">More...</a><br /></td></tr>
<tr class="separator:gac400a6861c1d0ee565ad5fac914a7220"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga72bcaac2f32ad480f79204f868309c31"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">XIpiPsu_WriteReg</a>(BaseAddress,  RegOffset,  Data)&#160;&#160;&#160;Xil_Out32(((BaseAddress) + (RegOffset)), (Data))</td></tr>
<tr class="memdesc:ga72bcaac2f32ad480f79204f868309c31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a value into a register specified by base address and offset.  <a href="#ga72bcaac2f32ad480f79204f868309c31">More...</a><br /></td></tr>
<tr class="separator:ga72bcaac2f32ad480f79204f868309c31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa4e2694e0d28168f195f87583a34190c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#gaa4e2694e0d28168f195f87583a34190c">XIpiPsu_InterruptEnable</a>(InstancePtr,  Mask)</td></tr>
<tr class="memdesc:gaa4e2694e0d28168f195f87583a34190c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable interrupts specified in <em>Mask</em>.  <a href="#gaa4e2694e0d28168f195f87583a34190c">More...</a><br /></td></tr>
<tr class="separator:gaa4e2694e0d28168f195f87583a34190c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad78cbbfba9e09be384e1fbe733f3dc12"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#gad78cbbfba9e09be384e1fbe733f3dc12">XIpiPsu_InterruptDisable</a>(InstancePtr,  Mask)</td></tr>
<tr class="memdesc:gad78cbbfba9e09be384e1fbe733f3dc12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable interrupts specified in <em>Mask</em>.  <a href="#gad78cbbfba9e09be384e1fbe733f3dc12">More...</a><br /></td></tr>
<tr class="separator:gad78cbbfba9e09be384e1fbe733f3dc12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b24a8f18c8abc17b7a26532da88cc7e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga5b24a8f18c8abc17b7a26532da88cc7e">XIpiPsu_GetInterruptStatus</a>(InstancePtr)</td></tr>
<tr class="memdesc:ga5b24a8f18c8abc17b7a26532da88cc7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <em>STATUS REGISTER</em> of the current IPI instance.  <a href="#ga5b24a8f18c8abc17b7a26532da88cc7e">More...</a><br /></td></tr>
<tr class="separator:ga5b24a8f18c8abc17b7a26532da88cc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2919c49f2a05d552dedb148069e84045"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga2919c49f2a05d552dedb148069e84045">XIpiPsu_ClearInterruptStatus</a>(InstancePtr,  Mask)</td></tr>
<tr class="memdesc:ga2919c49f2a05d552dedb148069e84045"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the <em>STATUS REGISTER</em> of the current IPI instance.  <a href="#ga2919c49f2a05d552dedb148069e84045">More...</a><br /></td></tr>
<tr class="separator:ga2919c49f2a05d552dedb148069e84045"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a62cac5d53ded4028a5f1586e390645"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga4a62cac5d53ded4028a5f1586e390645">XIpiPsu_GetObsStatus</a>(InstancePtr)</td></tr>
<tr class="memdesc:ga4a62cac5d53ded4028a5f1586e390645"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <em>OBSERVATION REGISTER</em> of the current IPI instance.  <a href="#ga4a62cac5d53ded4028a5f1586e390645">More...</a><br /></td></tr>
<tr class="separator:ga4a62cac5d53ded4028a5f1586e390645"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga9fb4494480ae0079422956f2af1da357"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga9fb4494480ae0079422956f2af1da357">XIpiPsu_CfgInitialize</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr, <a class="el" href="struct_x_ipi_psu___config.html">XIpiPsu_Config</a> *CfgPtr, UINTPTR EffectiveAddress)</td></tr>
<tr class="memdesc:ga9fb4494480ae0079422956f2af1da357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the Instance pointer based on a given Config Pointer.  <a href="#ga9fb4494480ae0079422956f2af1da357">More...</a><br /></td></tr>
<tr class="separator:ga9fb4494480ae0079422956f2af1da357"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c55b8deb0e6b0a4ff355ad3a74aa2f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga9c55b8deb0e6b0a4ff355ad3a74aa2f1">XIpiPsu_Reset</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga9c55b8deb0e6b0a4ff355ad3a74aa2f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the given IPI register set.  <a href="#ga9c55b8deb0e6b0a4ff355ad3a74aa2f1">More...</a><br /></td></tr>
<tr class="separator:ga9c55b8deb0e6b0a4ff355ad3a74aa2f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8aa0005ec03abef3b3c1a506cb924e6e"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga8aa0005ec03abef3b3c1a506cb924e6e">XIpiPsu_TriggerIpi</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr, u32 DestCpuMask)</td></tr>
<tr class="memdesc:ga8aa0005ec03abef3b3c1a506cb924e6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trigger an IPI to a Destination CPU.  <a href="#ga8aa0005ec03abef3b3c1a506cb924e6e">More...</a><br /></td></tr>
<tr class="separator:ga8aa0005ec03abef3b3c1a506cb924e6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf633cefd9970c417079c0922577933e8"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#gaf633cefd9970c417079c0922577933e8">XIpiPsu_PollForAck</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr, u32 DestCpuMask, u32 TimeOutCount)</td></tr>
<tr class="memdesc:gaf633cefd9970c417079c0922577933e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Poll for an acknowledgement using Observation Register.  <a href="#gaf633cefd9970c417079c0922577933e8">More...</a><br /></td></tr>
<tr class="separator:gaf633cefd9970c417079c0922577933e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga64113249dac23760b5cc0e9d038f8361"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga64113249dac23760b5cc0e9d038f8361">XIpiPsu_ReadMessage</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr, u32 SrcCpuMask, u32 *MsgPtr, u32 MsgLength, u8 BufferType)</td></tr>
<tr class="memdesc:ga64113249dac23760b5cc0e9d038f8361"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read an Incoming Message from a Source.  <a href="#ga64113249dac23760b5cc0e9d038f8361">More...</a><br /></td></tr>
<tr class="separator:ga64113249dac23760b5cc0e9d038f8361"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga21edd11331c715ee4b2c7a34471eac0d"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga21edd11331c715ee4b2c7a34471eac0d">XIpiPsu_WriteMessage</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr, u32 DestCpuMask, u32 *MsgPtr, u32 MsgLength, u8 BufferType)</td></tr>
<tr class="memdesc:ga21edd11331c715ee4b2c7a34471eac0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a Message to Destination.  <a href="#ga21edd11331c715ee4b2c7a34471eac0d">More...</a><br /></td></tr>
<tr class="separator:ga21edd11331c715ee4b2c7a34471eac0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaafe5e7a11e3d1fdd01a255521332272"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_ipi_psu___config.html">XIpiPsu_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#gaaafe5e7a11e3d1fdd01a255521332272">XIpiPsu_LookupConfig</a> (u32 DeviceId)</td></tr>
<tr class="memdesc:gaaafe5e7a11e3d1fdd01a255521332272"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks up the device configuration based on the unique device ID.  <a href="#gaaafe5e7a11e3d1fdd01a255521332272">More...</a><br /></td></tr>
<tr class="separator:gaaafe5e7a11e3d1fdd01a255521332272"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga2919c49f2a05d552dedb148069e84045"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2919c49f2a05d552dedb148069e84045">&#9670;&nbsp;</a></span>XIpiPsu_ClearInterruptStatus</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIpiPsu_ClearInterruptStatus</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Mask&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8h.html">xipipsu.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">XIpiPsu_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div><div class="line">                XIPIPSU_ISR_OFFSET, \</div><div class="line">                ((Mask) &amp; XIPIPSU_ALL_MASK));</div><div class="ttc" id="group__ipipsu__v1__0_html_ga72bcaac2f32ad480f79204f868309c31"><div class="ttname"><a href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">XIpiPsu_WriteReg</a></div><div class="ttdeci">#define XIpiPsu_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">Write a value into a register specified by base address and offset. </div><div class="ttdef"><b>Definition:</b> xipipsu.h:173</div></div>
</div><!-- fragment -->
<p>Clear the <em>STATUS REGISTER</em> of the current IPI instance. </p>
<p>The corresponding interrupt status for each bit set to 1 in <em>Mask</em>, will be cleared</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the instance to be worked on. </td></tr>
    <tr><td class="paramname">Mask</td><td>corresponding to the source CPU*</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function should be used after handling the IPI. Clearing the status will automatically clear the corresponding bit in OBSERVATION register of Source CPU C-style signature void <a class="el" href="group__ipipsu__v1__0.html#ga2919c49f2a05d552dedb148069e84045" title="Clear the STATUS REGISTER of the current IPI instance. ">XIpiPsu_ClearInterruptStatus(XIpiPsu *InstancePtr, u32 Mask)</a> </dd></dl>

</div>
</div>
<a id="ga5b24a8f18c8abc17b7a26532da88cc7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5b24a8f18c8abc17b7a26532da88cc7e">&#9670;&nbsp;</a></span>XIpiPsu_GetInterruptStatus</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIpiPsu_GetInterruptStatus</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8h.html">xipipsu.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__ipipsu__v1__0.html#gac400a6861c1d0ee565ad5fac914a7220">XIpiPsu_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div><div class="line">                XIPIPSU_ISR_OFFSET)</div><div class="ttc" id="group__ipipsu__v1__0_html_gac400a6861c1d0ee565ad5fac914a7220"><div class="ttname"><a href="group__ipipsu__v1__0.html#gac400a6861c1d0ee565ad5fac914a7220">XIpiPsu_ReadReg</a></div><div class="ttdeci">#define XIpiPsu_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">Read the register specified by the base address and offset. </div><div class="ttdef"><b>Definition:</b> xipipsu.h:155</div></div>
</div><!-- fragment -->
<p>Get the <em>STATUS REGISTER</em> of the current IPI instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the instance to be worked on. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the Interrupt Status register(ISR) contents </dd></dl>
<dl class="section note"><dt>Note</dt><dd>User needs to parse this 32-bit value to check the source CPU C-style signature u32 <a class="el" href="group__ipipsu__v1__0.html#ga5b24a8f18c8abc17b7a26532da88cc7e" title="Get the STATUS REGISTER of the current IPI instance. ">XIpiPsu_GetInterruptStatus(XIpiPsu *InstancePtr)</a> </dd></dl>

</div>
</div>
<a id="ga4a62cac5d53ded4028a5f1586e390645"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4a62cac5d53ded4028a5f1586e390645">&#9670;&nbsp;</a></span>XIpiPsu_GetObsStatus</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIpiPsu_GetObsStatus</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8h.html">xipipsu.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__ipipsu__v1__0.html#gac400a6861c1d0ee565ad5fac914a7220">XIpiPsu_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div><div class="line">                XIPIPSU_OBS_OFFSET)</div><div class="ttc" id="group__ipipsu__v1__0_html_gac400a6861c1d0ee565ad5fac914a7220"><div class="ttname"><a href="group__ipipsu__v1__0.html#gac400a6861c1d0ee565ad5fac914a7220">XIpiPsu_ReadReg</a></div><div class="ttdeci">#define XIpiPsu_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">Read the register specified by the base address and offset. </div><div class="ttdef"><b>Definition:</b> xipipsu.h:155</div></div>
</div><!-- fragment -->
<p>Get the <em>OBSERVATION REGISTER</em> of the current IPI instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the instance to be worked on. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the Observation register(OBS) contents </dd></dl>
<dl class="section note"><dt>Note</dt><dd>User needs to parse this 32-bit value to check the status of individual CPUs C-style signature u32 <a class="el" href="group__ipipsu__v1__0.html#ga4a62cac5d53ded4028a5f1586e390645" title="Get the OBSERVATION REGISTER of the current IPI instance. ">XIpiPsu_GetObsStatus(XIpiPsu *InstancePtr)</a> </dd></dl>

</div>
</div>
<a id="gad78cbbfba9e09be384e1fbe733f3dc12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad78cbbfba9e09be384e1fbe733f3dc12">&#9670;&nbsp;</a></span>XIpiPsu_InterruptDisable</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIpiPsu_InterruptDisable</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Mask&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8h.html">xipipsu.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">XIpiPsu_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div><div class="line">                XIPIPSU_IDR_OFFSET, \</div><div class="line">                ((Mask) &amp; XIPIPSU_ALL_MASK));</div><div class="ttc" id="group__ipipsu__v1__0_html_ga72bcaac2f32ad480f79204f868309c31"><div class="ttname"><a href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">XIpiPsu_WriteReg</a></div><div class="ttdeci">#define XIpiPsu_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">Write a value into a register specified by base address and offset. </div><div class="ttdef"><b>Definition:</b> xipipsu.h:173</div></div>
</div><!-- fragment -->
<p>Disable interrupts specified in <em>Mask</em>. </p>
<p>The corresponding interrupt for each bit set to 1 in <em>Mask</em>, will be disabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the instance to be worked on. </td></tr>
    <tr><td class="paramname">Mask</td><td>contains a bit mask of interrupts to disable. The mask can be formed using a set of bitwise or'd values of individual CPU masks</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature void <a class="el" href="group__ipipsu__v1__0.html#gad78cbbfba9e09be384e1fbe733f3dc12" title="Disable interrupts specified in Mask. ">XIpiPsu_InterruptDisable(XIpiPsu *InstancePtr, u32 Mask)</a> </dd></dl>

</div>
</div>
<a id="gaa4e2694e0d28168f195f87583a34190c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4e2694e0d28168f195f87583a34190c">&#9670;&nbsp;</a></span>XIpiPsu_InterruptEnable</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIpiPsu_InterruptEnable</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Mask&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8h.html">xipipsu.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">XIpiPsu_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \</div><div class="line">                XIPIPSU_IER_OFFSET, \</div><div class="line">                ((Mask) &amp; XIPIPSU_ALL_MASK));</div><div class="ttc" id="group__ipipsu__v1__0_html_ga72bcaac2f32ad480f79204f868309c31"><div class="ttname"><a href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">XIpiPsu_WriteReg</a></div><div class="ttdeci">#define XIpiPsu_WriteReg(BaseAddress, RegOffset, Data)</div><div class="ttdoc">Write a value into a register specified by base address and offset. </div><div class="ttdef"><b>Definition:</b> xipipsu.h:173</div></div>
</div><!-- fragment -->
<p>Enable interrupts specified in <em>Mask</em>. </p>
<p>The corresponding interrupt for each bit set to 1 in <em>Mask</em>, will be enabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the instance to be worked on. </td></tr>
    <tr><td class="paramname">Mask</td><td>contains a bit mask of interrupts to enable. The mask can be formed using a set of bitwise or'd values of individual CPU masks</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature void <a class="el" href="group__ipipsu__v1__0.html#gaa4e2694e0d28168f195f87583a34190c" title="Enable interrupts specified in Mask. ">XIpiPsu_InterruptEnable(XIpiPsu *InstancePtr, u32 Mask)</a> </dd></dl>

</div>
</div>
<a id="gac400a6861c1d0ee565ad5fac914a7220"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac400a6861c1d0ee565ad5fac914a7220">&#9670;&nbsp;</a></span>XIpiPsu_ReadReg</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIpiPsu_ReadReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;Xil_In32((BaseAddress) + (RegOffset))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8h.html">xipipsu.h</a>&gt;</code></p>

<p>Read the register specified by the base address and offset. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>is the base address of the IPI instance </td></tr>
    <tr><td class="paramname">RegOffset</td><td>is the offset of the register relative to base</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Value of the specified register </dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature u32 <a class="el" href="group__ipipsu__v1__0.html#gac400a6861c1d0ee565ad5fac914a7220" title="Read the register specified by the base address and offset. ">XIpiPsu_ReadReg(u32 BaseAddress, u32 RegOffset)</a> </dd></dl>

<p class="reference">Referenced by <a class="el" href="group__ipipsu__v1__0.html#gaf633cefd9970c417079c0922577933e8">XIpiPsu_PollForAck()</a>.</p>

</div>
</div>
<a id="ga72bcaac2f32ad480f79204f868309c31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga72bcaac2f32ad480f79204f868309c31">&#9670;&nbsp;</a></span>XIpiPsu_WriteReg</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XIpiPsu_WriteReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Data&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;Xil_Out32(((BaseAddress) + (RegOffset)), (Data))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8h.html">xipipsu.h</a>&gt;</code></p>

<p>Write a value into a register specified by base address and offset. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>is the base address of the IPI instance </td></tr>
    <tr><td class="paramname">RegOffset</td><td>is the offset of the register relative to base </td></tr>
    <tr><td class="paramname">Data</td><td>is a 32-bit value that is to be written into the specified register</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature void <a class="el" href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31" title="Write a value into a register specified by base address and offset. ">XIpiPsu_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)</a> </dd></dl>

<p class="reference">Referenced by <a class="el" href="group__ipipsu__v1__0.html#ga9c55b8deb0e6b0a4ff355ad3a74aa2f1">XIpiPsu_Reset()</a>, and <a class="el" href="group__ipipsu__v1__0.html#ga8aa0005ec03abef3b3c1a506cb924e6e">XIpiPsu_TriggerIpi()</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9fb4494480ae0079422956f2af1da357"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9fb4494480ae0079422956f2af1da357">&#9670;&nbsp;</a></span>XIpiPsu_CfgInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XStatus XIpiPsu_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_ipi_psu___config.html">XIpiPsu_Config</a> *&#160;</td>
          <td class="paramname"><em>CfgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>EffectiveAddress</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8c.html">xipipsu.c</a>&gt;</code></p>

<p>Initialize the Instance pointer based on a given Config Pointer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the instance to be worked on </td></tr>
    <tr><td class="paramname">CfgPtr</td><td>is the device configuration structure containing required hardware build data </td></tr>
    <tr><td class="paramname">EffectiveAddress</td><td>is the base address of the device. If address translation is not utilized, this parameter can be passed in using CfgPtr-&gt;Config.BaseAddress to specify the physical base address. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if initialization was successful XST_FAILURE in case of failure </dd></dl>

<p class="reference">References <a class="el" href="struct_x_ipi_psu___config.html#aaca08e14d9bc9e6ca2fe327e87a963dc">XIpiPsu_Config::BaseAddress</a>, <a class="el" href="struct_x_ipi_psu___config.html#a2057231c9bccf22dadbb50ae9ef93222">XIpiPsu_Config::BitMask</a>, <a class="el" href="struct_x_ipi_psu___target.html#ad8cf0011981eb538784e520195585e74">XIpiPsu_Target::BufferIndex</a>, <a class="el" href="struct_x_ipi_psu.html#ad9074c920ef0af4db9ea831e463d65ad">XIpiPsu::Config</a>, <a class="el" href="struct_x_ipi_psu___config.html#a1ff848d153b0a8d32fa5a04396e1a89a">XIpiPsu_Config::DeviceId</a>, <a class="el" href="struct_x_ipi_psu___config.html#a3382d79fc242c571c9649aa91629689f">XIpiPsu_Config::IntId</a>, <a class="el" href="struct_x_ipi_psu.html#adefbfd74e9c2ee38710b9ed805504a68">XIpiPsu::IsReady</a>, <a class="el" href="struct_x_ipi_psu___target.html#a4ac80767ed4dcfd90d9a02db6a2a8eb4">XIpiPsu_Target::Mask</a>, and <a class="el" href="struct_x_ipi_psu___config.html#a8df4537dada42c7a73d1072ad59d2626">XIpiPsu_Config::TargetCount</a>.</p>

</div>
</div>
<a id="gaaafe5e7a11e3d1fdd01a255521332272"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaafe5e7a11e3d1fdd01a255521332272">&#9670;&nbsp;</a></span>XIpiPsu_LookupConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_ipi_psu___config.html">XIpiPsu_Config</a> * XIpiPsu_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8h.html">xipipsu.h</a>&gt;</code></p>

<p>Looks up the device configuration based on the unique device ID. </p>
<p>A table contains the configuration info for each device in the system.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>contains the ID of the device to look up the configuration for.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the configuration found or NULL if the specified device ID was not found. See <a class="el" href="xipipsu_8h.html">xipipsu.h</a> for the definition of <a class="el" href="struct_x_ipi_psu___config.html" title="This typedef contains configuration information for the device. ">XIpiPsu_Config</a>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">Referenced by <a class="el" href="xipipsu__self__test__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
<a id="gaf633cefd9970c417079c0922577933e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf633cefd9970c417079c0922577933e8">&#9670;&nbsp;</a></span>XIpiPsu_PollForAck()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XStatus XIpiPsu_PollForAck </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>DestCpuMask</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>TimeOutCount</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8c.html">xipipsu.c</a>&gt;</code></p>

<p>Poll for an acknowledgement using Observation Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the pointer to current IPI instance </td></tr>
    <tr><td class="paramname">DestCpuMask</td><td>is the Mask of the destination CPU from which ACK is expected </td></tr>
    <tr><td class="paramname">TimeOutCount</td><td>is the Count after which the routines returns failure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful XST_FAILURE if a timeout occurred </dd></dl>

<p class="reference">References <a class="el" href="struct_x_ipi_psu___config.html#aaca08e14d9bc9e6ca2fe327e87a963dc">XIpiPsu_Config::BaseAddress</a>, <a class="el" href="struct_x_ipi_psu.html#ad9074c920ef0af4db9ea831e463d65ad">XIpiPsu::Config</a>, <a class="el" href="struct_x_ipi_psu.html#adefbfd74e9c2ee38710b9ed805504a68">XIpiPsu::IsReady</a>, and <a class="el" href="group__ipipsu__v1__0.html#gac400a6861c1d0ee565ad5fac914a7220">XIpiPsu_ReadReg</a>.</p>

</div>
</div>
<a id="ga64113249dac23760b5cc0e9d038f8361"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga64113249dac23760b5cc0e9d038f8361">&#9670;&nbsp;</a></span>XIpiPsu_ReadMessage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XStatus XIpiPsu_ReadMessage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>SrcCpuMask</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>MsgLength</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BufferType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8c.html">xipipsu.c</a>&gt;</code></p>

<p>Read an Incoming Message from a Source. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the pointer to current IPI instance </td></tr>
    <tr><td class="paramname">SrcCpuMask</td><td>is the Device Mask for the CPU which has sent the message </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>is the pointer to Buffer to which the read message needs to be stored </td></tr>
    <tr><td class="paramname">MsgLength</td><td>is the length of the buffer/message </td></tr>
    <tr><td class="paramname">BufferType</td><td>is the type of buffer (XIPIPSU_BUF_TYPE_MSG or XIPIPSU_BUF_TYPE_RESP)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful XST_FAILURE if an error occurred </dd></dl>

<p class="reference">References <a class="el" href="struct_x_ipi_psu.html#adefbfd74e9c2ee38710b9ed805504a68">XIpiPsu::IsReady</a>.</p>

</div>
</div>
<a id="ga9c55b8deb0e6b0a4ff355ad3a74aa2f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9c55b8deb0e6b0a4ff355ad3a74aa2f1">&#9670;&nbsp;</a></span>XIpiPsu_Reset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XIpiPsu_Reset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8c.html">xipipsu.c</a>&gt;</code></p>

<p>Reset the given IPI register set. </p>
<p>This function can be called to disable the IPIs from all the sources and clear any pending IPIs in status register</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the pointer to current IPI instance </td></tr>
  </table>
  </dd>
</dl>

<p class="reference">References <a class="el" href="struct_x_ipi_psu___config.html#aaca08e14d9bc9e6ca2fe327e87a963dc">XIpiPsu_Config::BaseAddress</a>, <a class="el" href="struct_x_ipi_psu.html#ad9074c920ef0af4db9ea831e463d65ad">XIpiPsu::Config</a>, <a class="el" href="struct_x_ipi_psu.html#adefbfd74e9c2ee38710b9ed805504a68">XIpiPsu::IsReady</a>, and <a class="el" href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">XIpiPsu_WriteReg</a>.</p>

</div>
</div>
<a id="ga8aa0005ec03abef3b3c1a506cb924e6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8aa0005ec03abef3b3c1a506cb924e6e">&#9670;&nbsp;</a></span>XIpiPsu_TriggerIpi()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XStatus XIpiPsu_TriggerIpi </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>DestCpuMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8c.html">xipipsu.c</a>&gt;</code></p>

<p>Trigger an IPI to a Destination CPU. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the pointer to current IPI instance </td></tr>
    <tr><td class="paramname">DestCpuMask</td><td>is the Mask of the CPU to which IPI is to be triggered</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful XST_FAILURE if an error occurred </dd></dl>

<p class="reference">References <a class="el" href="struct_x_ipi_psu___config.html#aaca08e14d9bc9e6ca2fe327e87a963dc">XIpiPsu_Config::BaseAddress</a>, <a class="el" href="struct_x_ipi_psu.html#ad9074c920ef0af4db9ea831e463d65ad">XIpiPsu::Config</a>, <a class="el" href="struct_x_ipi_psu.html#adefbfd74e9c2ee38710b9ed805504a68">XIpiPsu::IsReady</a>, and <a class="el" href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">XIpiPsu_WriteReg</a>.</p>

</div>
</div>
<a id="ga21edd11331c715ee4b2c7a34471eac0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga21edd11331c715ee4b2c7a34471eac0d">&#9670;&nbsp;</a></span>XIpiPsu_WriteMessage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XStatus XIpiPsu_WriteMessage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>DestCpuMask</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>MsgLength</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BufferType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xipipsu_8c.html">xipipsu.c</a>&gt;</code></p>

<p>Send a Message to Destination. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the pointer to current IPI instance </td></tr>
    <tr><td class="paramname">DestCpuMask</td><td>is the Device Mask for the destination CPU </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>is the pointer to Buffer which contains the message to be sent </td></tr>
    <tr><td class="paramname">MsgLength</td><td>is the length of the buffer/message </td></tr>
    <tr><td class="paramname">BufferType</td><td>is the type of buffer (XIPIPSU_BUF_TYPE_MSG or XIPIPSU_BUF_TYPE_RESP)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful XST_FAILURE if an error occurred </dd></dl>

<p class="reference">References <a class="el" href="struct_x_ipi_psu.html#adefbfd74e9c2ee38710b9ed805504a68">XIpiPsu::IsReady</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
